Document the limited situations in which ostree-grub2 will work in practice

diff --git a/debian/changelog b/debian/changelog
index 2165344ce9b04e247ad19ef4aa5890e8866adeee..1db4f23c7449d62c64e4284d4fc2a7465c4ab3e4 100644 (file)
--- a/debian/changelog
+++ b/debian/changelog
@@ -27,6 +27,8 @@ ostree (2016.1+deb-1) UNRELEASED; urgency=medium
   * Redirect libexecdir to /usr/lib (not /usr/lib/${multiarch}) since we don't
     need multiarch for anything that's installed there, fixing a broken
     symlink in ostree-grub2
+  * Document the limited situations in which ostree-grub2 will work in
+    practice
 
  -- Simon McVittie <smcv@debian.org>  Wed, 27 Jan 2016 13:04:34 +0100
 

diff --git a/debian/control b/debian/control
index ba94f1561d3c8e36632f2a7bc1df6151db07a439..e20aced2faccf5df89ff3e011777587f1e4f1d6f 100644 (file)
--- a/debian/control
+++ b/debian/control
@@ -116,6 +116,7 @@ Description: content-addressed filesystem for operating system binaries
 Package: ostree-grub2
 Architecture: all
 Depends:
+ dracut,
  ${misc:Depends},
 Recommends:
  grub-efi-amd64 | grub-pc,
@@ -126,6 +127,15 @@ Description: GRUB 2 configuration for ostree
  disadvantages) of both.
  .
  This package contains configuration snippets for using ostree with GRUB 2.
+ This integration currently has some limitations:
+ .
+  - the initramfs must have been made using dracut
+  - the root filesystem must be one that dracut can mount without a root=
+    command-line argument (an EFI partition with the GUID defined in
+    the Discoverable Partitions specification)
+  - /boot must be a separate partition
+ .
+ See README.Debian.gz for more details.
 
 Package: ostree-tests
 Architecture: any

diff --git a/debian/ostree-grub2.README.Debian b/debian/ostree-grub2.README.Debian
new file mode 100644 (file)
index 0000000..f156b6a
--- /dev/null
+++ b/debian/ostree-grub2.README.Debian
@@ -0,0 +1,10 @@
+This package contains configuration snippets for using ostree with GRUB 2.
+This integration currently has some limitations:
+
+  - the initramfs must have been made using dracut
+  - the root filesystem must be one that dracut can mount without a root=
+    command-line argument (an EFI partition with the GUID defined in
+    the Discoverable Partitions specification[1])
+  - /boot must be a separate partition
+
+[1] https://www.freedesktop.org/wiki/Specifications/DiscoverablePartitionsSpec/